Payment Methods Biz API

(0 reviews)

GET- paymentMethod (Digital to SF)

GET

This operation retrieves list of payment methods of a billingAccountNumber from SF

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (PR) identifying the business unit.	Y

Security Headers

name	type	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y

name	type	description	required
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	N

Query Param

name	type	description	required
relatedParty.@type	string	type of the relatedParty to search. Could be different, depending on the use case. For Peacock Mobile Project the value is channel".	Y
relatedParty.name	string	The name of the relatedParty For Peacock Mobile Project the values must be Digital/IVR	Y
account.id	string	Value of Billing Account Number Conditional mandatory. either Billing Account Number or MSISDN should be passed as queryparam	N*
account.relatedParty.id	string	Value of MSISDN Conditional mandatory. either Billing Account Number or MSISDN should be passed as queryparam	N*

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - list request processed successfully, response body contains array of entities corresponding to the requested resource.

[
    {
        "id":"PM-a6I3K0000008znQUAQ",
        "token": "cGF5bWVudG1ldGhvZF9jY181a25obmtzZg",
        "@type":"Tokenised Credit Card",
        "@baseType": "paymentMethod",
        "account": [
            {
                "id": "S-10008",
                "@type": "BillingAccount",
                "ratingType":"postpaid",
                "autopayEnabled": "true"
            }
        ],
        "relatedParty":[{

                "name": "BrainTreeToken",
                "@type": "paymentGatewayType"
        }],
        "autopayEnabled": "true"
    }
]

Definitions

Each of the response parameters is detailed.

name	type	description	required	possible values
id	string	paymentMethod id	Y	PM-a6I3K0000008znQUAQ,2,13
token	string	Braintree token	Y	cGF5bWVudG1ldGhvZF9jY19i
@type	string	Payment Method Type.Eg:Tokenised Credit Card,Credit Card,Electronic Cheque (ACH),Direct Debit,Tokenised Debit Card	Y	Tokenised Credit Card , Credit Card, Electronic Cheque (ACH),Direct Debit,Tokenised Debit Card
@baseType	string	indicates the baseType of object	Y	PaymentMethod
account	array		Y
account.id	string	Billing Account Number value	Y	PM-a6I63000000DZmrEAG
account.@type	string	type of account.here it is Billing Account	Y	BillingAccount
account.ratingType	String	Indicated whether the account follows a specific payment option such as prepaid or postpaid	Y	prepaid or postpaid
account.autopayEnabled	string	indicates if the billing account supports automatic payments	Y	true,false
relatedParty	array		Y
relatedParty.name	string	Name of the relatedParty	Y	BrainTreeToken
relatedParty.@type	string	Type of the relatedParty	Y	paymentGatewayType
autopayEnabled	string	Indicate that payment method is enabled or not for Automatic Payments	Y	true,false